DigiOffice Gateway Web Services

ProcessProjectRequestMessage

import java.math.*
import java.util.*
import net.servicestack.client.*


open class ProcessProjectRequestMessage
{
    var InstanceId:UUID? = null
    var ProjectRequest:ProjectRequestMessage? = null
}

open class ProjectRequestMessage
{
    var Header:Header? = null
    var ProjectReference:Reference? = null
    var IncludeHousingTypes:Boolean? = null
    var IncludeConstructionBlocks:Boolean? = null
    var IncludeConstructionNumbers:Boolean? = null
    var IncludeDocuments:Boolean? = null
    var IncludePurchaseContracts:Boolean? = null
}

open class Header
{
    var MessageID:String? = null
    var Timestamp:Date? = null
    var Sender:Party? = null
    var Recipient:Party? = null
    var RequestMessageID:Object? = null
}

open class Party
{
    var Title:String? = null
    var Code:String? = null
    var Version:String? = null
    var Environment:Environment? = null
}

open class Environment
{
    var Title:String? = null
    var Code:String? = null
}

open class Reference
{
    var GlobalID:String? = null
    var Title:String? = null
}

open class ProjectResponseMessage
{
    var Header:Header? = null
    var ProjectReference:Reference? = null
    var Project:Project? = null
    var HousingTypes:ArrayList<HousingType>? = null
    var ConstructionBlocks:ArrayList<ConstructionBlock>? = null
    var ConstructionNumbers:ArrayList<ConstructionNumber>? = null
    var Documents:ArrayList<Document>? = null
    var PurchaseContracts:ArrayList<PurchaseContract>? = null
}

open class Project
{
    var GlobalID:String? = null
    var CreationDate:Date? = null
    var CreatedBy:String? = null
    var ModifiedDate:Date? = null
    var ModifiedBy:String? = null
    var Code:String? = null
    var Name:String? = null
    var Description1:String? = null
    var Description2:String? = null
    var Address:Address? = null
    var MailingAddress:MailingAddress? = null
    var ProjectCategoryReference:Reference? = null
    var ProjectTypeReference:Reference? = null
    var ProjectStatusReference:Reference? = null
    var StartDate:Date? = null
    var EndDate:Date? = null
    var CompletionDate:Date? = null
    var Inactive:Boolean? = null
    var Website:String? = null
    var IsTemplateProject:Boolean? = null
    var CustomFields:ArrayList<CustomField>? = null
}

open class Address
{
    var AddressLine1:String? = null
    var AddressLine2:String? = null
    var HouseNumber:String? = null
    var HouseNumberSuffix:String? = null
    var PostalCode:String? = null
    var City:String? = null
    var Country:Reference? = null
}

open class MailingAddress
{
    var POBox:String? = null
    var PostalCode:String? = null
    var City:String? = null
    var Country:Reference? = null
}

open class CustomField
{
    var Name:String? = null
    var Value:String? = null
}

open class HousingType
{
    var GlobalID:String? = null
    var ProjectReference:Reference? = null
    var Code:String? = null
    var Description:String? = null
    var CustomFields:ArrayList<CustomField>? = null
    var CreationDate:Date? = null
    var CreatedBy:String? = null
    var ModifiedDate:Date? = null
    var ModifiedBy:String? = null
}

open class ConstructionBlock
{
    var GlobalID:String? = null
    var ProjectReference:Reference? = null
    var Code:String? = null
    var Description:String? = null
    var CustomFields:ArrayList<CustomField>? = null
    var CreationDate:Date? = null
    var CreatedBy:String? = null
    var ModifiedDate:Date? = null
    var ModifiedBy:String? = null
}

open class ConstructionNumber
{
    var GlobalID:String? = null
    var ProjectReference:Reference? = null
    var HousingTypeReference:Reference? = null
    var ConstructionBlockReference:Reference? = null
    var Code:String? = null
    var Description:String? = null
    var Address:Address? = null
    var RentalHouse:Boolean? = null
    var GuaranteeCertificateNumber:String? = null
    var Inactive:Boolean? = null
    var CustomFields:ArrayList<CustomField>? = null
    var CreationDate:Date? = null
    var CreatedBy:String? = null
    var ModifiedDate:Date? = null
    var ModifiedBy:String? = null
    var ViewingDate:Date? = null
    var ViewingDateSpecified:Boolean? = null
    var DeliveryDate:Date? = null
    var DeliveryDateSpecified:Boolean? = null
}

open class Document : ICustomProperties
{
    var ID:UUID? = null
    var RootDocumentID:UUID? = null
    var RegistrationprofileID:UUID? = null
    var Title:String? = null
    var FullTitle:String? = null
    var Number:String? = null
    var Version:String? = null
    var ExternalNumber:String? = null
    var ExternalVersion:String? = null
    var InternalNumber:String? = null
    var InternalInvoiceNumber:String? = null
    var PersonID:Int? = null
    var RelationID:Int? = null
    var RelationTitle:String? = null
    var ProjectID:Int? = null
    var ProjectTitle:String? = null
    var Extension:String? = null
    var Date:Date? = null
    var CommentsCount:Int? = null
    var HasComments:Boolean? = null
    var HasPreview:Boolean? = null
    var ExtraField:String? = null
    var IsFavorite:Boolean? = null
    var DocumentcategoryText:String? = null
    var FileSize:Long? = null
    var FileDate:Date? = null
    var Hash:String? = null
    var HashType:String? = null
    var FileUrl:String? = null
    var StandardDocumentUrl:String? = null
    var IsCorporateIdentity:Boolean? = null
    var UserTitle:String? = null
    var IsFrozen:Boolean? = null
    var InternalCompanyID:Int? = null
    var DirectUrl:String? = null
    var AllowDigitalSigningOnlyOnPrimaryVersions:Boolean? = null
    var IsPrimaryVersion:Boolean? = null
    var FileExtension:String? = null
    var CustomProperties:HashMap<String,Object> = HashMap<String,Object>()
}

open class PurchaseContract
{
    var GlobalID:String? = null
    var Code:String? = null
    var Description:String? = null
    var ProjectReference:Reference? = null
    var ProductCode:String? = null
    var Relation:Relation? = null
    var Inactive:Boolean? = null
    var CustomFields:ArrayList<CustomField>? = null
    var CreationDate:Date? = null
    var CreatedBy:String? = null
    var ModifiedDate:Date? = null
    var ModifiedBy:String? = null
}

open class Relation
{
    var GlobalID:String? = null
    var NameLine1:String? = null
    var NameLine2:String? = null
    var Address:Address? = null
    var MailingAddress:MailingAddress? = null
    var Telephone:String? = null
    var Mobile:String? = null
    var Email:String? = null
    var IBAN:String? = null
    var BankAccountNumber:String? = null
    var Website:String? = null
    var Inactive:Boolean? = null
    var CustomFields:ArrayList<CustomField>? = null
    var CreationDate:Date? = null
    var CreatedBy:String? = null
    var ModifiedDate:Date? = null
    var ModifiedBy:String? = null
}

Kotlin ProcessProjectRequestMessage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/ProcessProjectRequestMessage HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProcessProjectRequestMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigiOffice.Integration.TBIXchangeAzure.Messages">
  <InstanceId>00000000-0000-0000-0000-000000000000</InstanceId>
  <ProjectRequest>
    <Header>
      <MessageID>String</MessageID>
      <Recipient>
        <Code>String</Code>
        <Environment>
          <Code>String</Code>
          <Title>String</Title>
        </Environment>
        <Title>String</Title>
        <Version>String</Version>
      </Recipient>
      <RequestMessageID />
      <Sender>
        <Code>String</Code>
        <Environment>
          <Code>String</Code>
          <Title>String</Title>
        </Environment>
        <Title>String</Title>
        <Version>String</Version>
      </Sender>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </Header>
    <IncludeConstructionBlocks>false</IncludeConstructionBlocks>
    <IncludeConstructionNumbers>false</IncludeConstructionNumbers>
    <IncludeDocuments>false</IncludeDocuments>
    <IncludeHousingTypes>false</IncludeHousingTypes>
    <IncludePurchaseContracts>false</IncludePurchaseContracts>
    <ProjectReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </ProjectReference>
  </ProjectRequest>
</ProcessProjectRequestMessage>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigiOffice.Integration.TBIXchangeAzure.Messages">
  <ConstructionBlocks>
    <ConstructionBlock>
      <Code>String</Code>
      <CreatedBy>String</CreatedBy>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <CustomFields>
        <CustomField>
          <Name>String</Name>
          <Value>String</Value>
        </CustomField>
      </CustomFields>
      <Description>String</Description>
      <GlobalID>String</GlobalID>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <ProjectReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </ProjectReference>
    </ConstructionBlock>
  </ConstructionBlocks>
  <ConstructionNumbers>
    <ConstructionNumber>
      <Address>
        <AddressLine1>String</AddressLine1>
        <AddressLine2>String</AddressLine2>
        <City>String</City>
        <Country>
          <GlobalID>String</GlobalID>
          <Title>String</Title>
        </Country>
        <HouseNumber>String</HouseNumber>
        <HouseNumberSuffix>String</HouseNumberSuffix>
        <PostalCode>String</PostalCode>
      </Address>
      <Code>String</Code>
      <ConstructionBlockReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </ConstructionBlockReference>
      <CreatedBy>String</CreatedBy>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <CustomFields>
        <CustomField>
          <Name>String</Name>
          <Value>String</Value>
        </CustomField>
      </CustomFields>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <DeliveryDateSpecified>false</DeliveryDateSpecified>
      <Description>String</Description>
      <GlobalID>String</GlobalID>
      <GuaranteeCertificateNumber>String</GuaranteeCertificateNumber>
      <HousingTypeReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </HousingTypeReference>
      <Inactive>false</Inactive>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <ProjectReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </ProjectReference>
      <RentalHouse>false</RentalHouse>
      <ViewingDate>0001-01-01T00:00:00</ViewingDate>
      <ViewingDateSpecified>false</ViewingDateSpecified>
    </ConstructionNumber>
  </ConstructionNumbers>
  <Documents>
    <Document>
      <Code>String</Code>
      <ConstructionBlockReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </ConstructionBlockReference>
      <ConstructionNumberReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </ConstructionNumberReference>
      <CreatedBy>String</CreatedBy>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <CustomFields>
        <CustomField>
          <Name>String</Name>
          <Value>String</Value>
        </CustomField>
      </CustomFields>
      <DeletedDate>0001-01-01T00:00:00</DeletedDate>
      <DeletedDateSpecified>false</DeletedDateSpecified>
      <DocumentTypeReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </DocumentTypeReference>
      <File>
        <Content>String</Content>
        <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
        <Name>String</Name>
        <Size>0</Size>
        <Type>String</Type>
      </File>
      <Floor>0</Floor>
      <FloorSpecified>false</FloorSpecified>
      <GlobalID>String</GlobalID>
      <HousingTypeReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </HousingTypeReference>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <NewestVersion>false</NewestVersion>
      <ProjectReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </ProjectReference>
      <RelationReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </RelationReference>
      <RootDocumentID>String</RootDocumentID>
      <Subject>String</Subject>
      <VersionNumber>String</VersionNumber>
    </Document>
  </Documents>
  <Header>
    <MessageID>String</MessageID>
    <Recipient>
      <Code>String</Code>
      <Environment>
        <Code>String</Code>
        <Title>String</Title>
      </Environment>
      <Title>String</Title>
      <Version>String</Version>
    </Recipient>
    <RequestMessageID />
    <Sender>
      <Code>String</Code>
      <Environment>
        <Code>String</Code>
        <Title>String</Title>
      </Environment>
      <Title>String</Title>
      <Version>String</Version>
    </Sender>
    <Timestamp>0001-01-01T00:00:00</Timestamp>
  </Header>
  <HousingTypes>
    <HousingType>
      <Code>String</Code>
      <CreatedBy>String</CreatedBy>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <CustomFields>
        <CustomField>
          <Name>String</Name>
          <Value>String</Value>
        </CustomField>
      </CustomFields>
      <Description>String</Description>
      <GlobalID>String</GlobalID>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <ProjectReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </ProjectReference>
    </HousingType>
  </HousingTypes>
  <Project>
    <Address>
      <AddressLine1>String</AddressLine1>
      <AddressLine2>String</AddressLine2>
      <City>String</City>
      <Country>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </Country>
      <HouseNumber>String</HouseNumber>
      <HouseNumberSuffix>String</HouseNumberSuffix>
      <PostalCode>String</PostalCode>
    </Address>
    <Code>String</Code>
    <CompletionDate>0001-01-01T00:00:00</CompletionDate>
    <CreatedBy>String</CreatedBy>
    <CreationDate>0001-01-01T00:00:00</CreationDate>
    <CustomFields>
      <CustomField>
        <Name>String</Name>
        <Value>String</Value>
      </CustomField>
    </CustomFields>
    <Description1>String</Description1>
    <Description2>String</Description2>
    <EndDate>0001-01-01T00:00:00</EndDate>
    <GlobalID>String</GlobalID>
    <Inactive>false</Inactive>
    <IsTemplateProject>false</IsTemplateProject>
    <MailingAddress>
      <City>String</City>
      <Country>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </Country>
      <POBox>String</POBox>
      <PostalCode>String</PostalCode>
    </MailingAddress>
    <ModifiedBy>String</ModifiedBy>
    <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
    <Name>String</Name>
    <ProjectCategoryReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </ProjectCategoryReference>
    <ProjectStatusReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </ProjectStatusReference>
    <ProjectTypeReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </ProjectTypeReference>
    <StartDate>0001-01-01T00:00:00</StartDate>
    <Website>String</Website>
  </Project>
  <ProjectReference>
    <GlobalID>String</GlobalID>
    <Title>String</Title>
  </ProjectReference>
  <PurchaseContracts>
    <PurchaseContract>
      <Code>String</Code>
      <CreatedBy>String</CreatedBy>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <CustomFields>
        <CustomField>
          <Name>String</Name>
          <Value>String</Value>
        </CustomField>
      </CustomFields>
      <Description>String</Description>
      <GlobalID>String</GlobalID>
      <Inactive>false</Inactive>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <ProductCode>String</ProductCode>
      <ProjectReference>
        <GlobalID>String</GlobalID>
        <Title>String</Title>
      </ProjectReference>
      <Relation>
        <Address>
          <AddressLine1>String</AddressLine1>
          <AddressLine2>String</AddressLine2>
          <City>String</City>
          <Country>
            <GlobalID>String</GlobalID>
            <Title>String</Title>
          </Country>
          <HouseNumber>String</HouseNumber>
          <HouseNumberSuffix>String</HouseNumberSuffix>
          <PostalCode>String</PostalCode>
        </Address>
        <BankAccountNumber>String</BankAccountNumber>
        <CreatedBy>String</CreatedBy>
        <CreationDate>0001-01-01T00:00:00</CreationDate>
        <CustomFields>
          <CustomField>
            <Name>String</Name>
            <Value>String</Value>
          </CustomField>
        </CustomFields>
        <Email>String</Email>
        <GlobalID>String</GlobalID>
        <IBAN>String</IBAN>
        <Inactive>false</Inactive>
        <MailingAddress>
          <City>String</City>
          <Country>
            <GlobalID>String</GlobalID>
            <Title>String</Title>
          </Country>
          <POBox>String</POBox>
          <PostalCode>String</PostalCode>
        </MailingAddress>
        <Mobile>String</Mobile>
        <ModifiedBy>String</ModifiedBy>
        <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
        <NameLine1>String</NameLine1>
        <NameLine2>String</NameLine2>
        <Telephone>String</Telephone>
        <Website>String</Website>
      </Relation>
    </PurchaseContract>
  </PurchaseContracts>
</ProjectResponseMessage>